/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package javax.servlet.jsp.tagext;

/**
 * Information on the attributes of a Tag, available at translation time. This class is instantiated from the Tag
 * Library Descriptor file (TLD).
 * <p>
 * Only the information needed to generate code is included here. Other information like SCHEMA for validation belongs
 * elsewhere.
 */

public class TagAttributeInfo {

    /**
     * "id" is wired in to be ID. There is no real benefit in having it be something else IDREFs are not handled any
     * differently.
     */
    public static final String ID = "id";

    /**
     * Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under request
     * from some JSP code that is parsing a TLD (Tag Library Descriptor).
     *
     * @param name     The name of the attribute.
     * @param required If this attribute is required in tag instances.
     * @param type     The name of the type of the attribute.
     * @param reqTime  Whether this attribute holds a request-time Attribute.
     */
    public TagAttributeInfo(String name, boolean required, String type, boolean reqTime) {
        this(name, required, type, reqTime, false);
    }

    /**
     * JSP 2.0 Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under
     * request from some JSP code that is parsing a TLD (Tag Library Descriptor).
     *
     * @param name     The name of the attribute.
     * @param required If this attribute is required in tag instances.
     * @param type     The name of the type of the attribute.
     * @param reqTime  Whether this attribute holds a request-time Attribute.
     * @param fragment Whether this attribute is of type JspFragment
     *
     * @since JSP 2.0
     */
    public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment) {
        this(name, required, type, reqTime, fragment, null, false, false, null, null);
    }

    /**
     * JSP 2.1 Constructor for TagAttributeInfo. This class is to be instantiated only from the TagLibrary code under
     * request from some JSP code that is parsing a TLD (Tag Library Descriptor).
     *
     * @param name             The name of the attribute.
     * @param required         If this attribute is required in tag instances.
     * @param type             The name of the type of the attribute.
     * @param reqTime          Whether this attribute holds a request-time Attribute.
     * @param fragment         Whether this attribute is of type JspFragment
     * @param description      Description of this attribute
     * @param deferredValue    Does this attribute accept value expressions (written as Strings) as attribute values the
     *                             evaluation of which is deferred until calculated by the tag
     * @param deferredMethod   Does this attribute accept method expressions (written as Strings) as attribute values
     *                             the evaluation of which is deferred until calculated by the tag
     * @param expectedTypeName The expected type when the deferred value is evaluated
     * @param methodSignature  The expected method signature if a deferred method
     *
     * @since JSP 2.1
     */
    public TagAttributeInfo(String name, boolean required, String type, boolean reqTime, boolean fragment,
            String description, boolean deferredValue, boolean deferredMethod, String expectedTypeName,
            String methodSignature) {
        this.name = name;
        this.required = required;
        this.type = type;
        this.reqTime = reqTime;
        this.fragment = fragment;
        this.description = description;
        this.deferredValue = deferredValue;
        this.deferredMethod = deferredMethod;
        this.expectedTypeName = expectedTypeName;
        this.methodSignature = methodSignature;
    }

    /**
     * The name of this attribute.
     *
     * @return the name of the attribute
     */
    public String getName() {
        return name;
    }

    /**
     * The type (as a String) of this attribute.
     *
     * @return the type of the attribute
     */
    public String getTypeName() {
        return type;
    }

    /**
     * Whether this attribute can hold a request-time value.
     *
     * @return if the attribute can hold a request-time value.
     */
    public boolean canBeRequestTime() {
        return reqTime;
    }

    /**
     * Whether this attribute is required.
     *
     * @return if the attribute is required.
     */
    public boolean isRequired() {
        return required;
    }

    /**
     * Convenience static method that goes through an array of TagAttributeInfo objects and looks for "id".
     *
     * @param tagAttributeInfos An array of TagAttributeInfo
     *
     * @return The TagAttributeInfo reference with name "id"
     */
    public static TagAttributeInfo getIdAttribute(TagAttributeInfo[] tagAttributeInfos) {
        for (TagAttributeInfo tagAttributeInfo : tagAttributeInfos) {
            if (tagAttributeInfo.getName().equals(ID)) {
                return tagAttributeInfo;
            }
        }
        return null; // no such attribute
    }

    /**
     * Whether this attribute is of type JspFragment.
     *
     * @return if the attribute is of type JspFragment
     *
     * @since JSP 2.0
     */
    public boolean isFragment() {
        return fragment;
    }

    /**
     * Returns a String representation of this TagAttributeInfo, suitable for debugging purposes.
     *
     * @return a String representation of this TagAttributeInfo
     */
    @Override
    public String toString() {
        StringBuilder b = new StringBuilder(64);
        b.append("name = " + name + " ");
        b.append("type = " + type + " ");
        b.append("reqTime = " + reqTime + " ");
        b.append("required = " + required + " ");
        b.append("fragment = " + fragment + " ");
        b.append("deferredValue = " + deferredValue + " ");
        b.append("expectedTypeName = " + expectedTypeName + " ");
        b.append("deferredMethod = " + deferredMethod + " ");
        b.append("methodSignature = " + methodSignature);
        return b.toString();
    }

    /*
     * private fields
     */
    private final String name;

    private final String type;

    private final boolean reqTime;

    private final boolean required;

    /*
     * private fields for JSP 2.0
     */
    private final boolean fragment;

    /*
     * private fields for JSP 2.1
     */
    private final String description;

    private final boolean deferredValue;

    private final boolean deferredMethod;

    private final String expectedTypeName;

    private final String methodSignature;

    /**
     * Does the attribute expect to be passed a deferred method?
     *
     * @return {@code true} if a deferred method expression is expected, otherwise {@code false}
     */
    public boolean isDeferredMethod() {
        return deferredMethod;
    }

    /**
     * Does the attribute expect to be passed a deferred value?
     *
     * @return {@code true} if a deferred value expression is expected, otherwise {@code false}
     */
    public boolean isDeferredValue() {
        return deferredValue;
    }

    /**
     * Obtain the description for the attribute,
     *
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * Obtain the type name, as a string, expected by this attribute.
     *
     * @return the type name, as a string
     */
    public String getExpectedTypeName() {
        return expectedTypeName;
    }

    /**
     * If this is a deferred method attribute, obtain the expected method signature.
     *
     * @return The expected method signature or {@code null} if this attribute is not a deferred method attribute
     */
    public String getMethodSignature() {
        return methodSignature;
    }
}
